home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _dtp / dtp / quotes / !Quotes / ReadMe < prev    next >
Text File  |  1994-09-18  |  23KB  |  456 lines

  1. Smart Quotes version 1.20
  2. ⌐ Sam Kington 6th September 1994
  3. See öBoring legal messageò for conditions of distribution.
  4. This program is freeware, *not* public domain ù i.e., I retain copyright.
  5.  
  6. Contents
  7. ********
  8.  
  9.    This ₧le contains the following sections (those marked * are essential to
  10. using Smart Quotes, the others less so):
  11.      *Å Warning... ù this program is RISC OS 3 (or later) only
  12.       Å Boring legal message ù terms of distribution
  13.       Å About the strange characters... ù if this looks strange on a PC
  14.       Å Iæm using an Acorn machine... ù donæt read this in the System font
  15.  
  16.      *Å Quotation marks ù how quotes work
  17.      *Å Ligatures and diphthongs ù how diphthongs work
  18.      *Å Typing mistakes ù which ones Smart Quotes can correct
  19.      *Å Menu structure, windows ù brief explanation
  20.      *Å Diphthong menu - what it does
  21.      *Å Settings window ù where you choose types of substitution
  22.       Å Choices dialogue box ù various preferences or choices
  23.       Å Other choices ù more choices
  24.       Å Characters dialogue box ù change the characters used for quotes
  25.      *Å Diphthongs window ù viewing and editing diphthongs
  26.       Å Using diphthongs ù hints and tips for diphthongs
  27.       Å How to contact me ù says it all really. Address, email, etc. 
  28.  
  29.    The ₧le Other.MoreInfo contains the following, more obscure stuff:
  30.       Å What these ₧les actually do ù explanation of all the ₧les
  31.       Å The ₧les you actually need ù how to make a smaller Smart Quotes
  32.       Å Miscellanea ù a few things that didnæt ₧t anywhere else
  33.       Å * commands ù commands provided by the module
  34.       Å Variables ù special variables used by Smart Quotes
  35.       Å Changing the font ù how to change the default font
  36.       Å Changes between previous versions ù whatæs been added, changed etc.
  37.       Å Thanks etc. ù various thank-yous, greets, comments, etc.
  38.       Å Known problems ù various problems with other programs etc.
  39.       Å Wish-list ù things I would like to do to Smart Quotes
  40.       
  41.    You may not have a ₧le called Other.MoreInfo, in which case you have a
  42. small version of Smart Quotes. The full version has source code and other
  43. goodies, and should be freely available from the place you got this version.
  44.  
  45.    The ₧le FileList contains a full list of the ₧les you should have.
  46.       
  47. Warning ù Smart Quotes needs the Filter Manager
  48. *********************************************** 
  49.  
  50.    Smart Quotes works by intercepting key events passed to WIMP
  51. applications, a facility which is only available under RISC OS 3 or later.
  52. It determines which version of RISC OS it is running under by checking
  53. whether the FilterManager is present or not ù so if you have RISC OS 3 or
  54. later, type *RMReinit FilterManager at the CLI prompt (F12 or Ctrl-F12) and
  55. try again.
  56.  
  57.    I am currently aware of four major versions of RISC OS, namely 2.00,
  58. 3.00 (early A5000s), 3.10 (most newish machines) and 3.50 (RISC PC). Smart
  59. Quotes will not work on RISC OS 2, will probably work on RISC OS 3.00 (it
  60. was quite buggy, apparently), will de₧nitely work on 3.10 (the version Iæve
  61. got), and will very probably work on 3.50 ù version 1.14 was tested on a
  62. RISC PC, and thereæs nothing fundamentally different (i.e. it still behaves
  63. the same way).
  64.  
  65.    If you come across any problems, please contact me (see öHow to contact
  66. meò at the end of this ₧le).
  67.  
  68. Boring legal message
  69. ********************
  70.  
  71.    This application is freeware, that is, it can be distributed freely as
  72. long as only reasonable charges are made for media and distribution, and as
  73. long as all the files are distributed intact, unmodified (see öThe ₧les
  74. you may haveò for a full list of files and lengths) ù but see below. I retain
  75. copyright on all program code and documentation.
  76.  
  77.    One slight exception is the set of library routines Other.ShortHelp,
  78. which may be distributed and used separately (for writing modules for
  79. instance). See the ₧le Other.ShortHDocs for more information.
  80.  
  81.    You may also freely distribute and use the module MoreHelp. No
  82. documentation is supplied here, but the application !MoreHelp should be
  83. available from the place you got Smart Quotes (if not, send a disc to me and
  84. Iæll send it to you, but mail me ₧rst).
  85.  
  86.    Given the size of Smart Quotes, and particularly the amount of excess
  87. garbage (source code etc.), you are allowed to distribute a öusefulò version
  88. of Smart Quotes, i.e. that produced by running SlimDown on a full version,
  89. provided:
  90.    1) You make it quite clear that this is not the complete version, and that
  91.    the source code and other interesting ₧les are not included in the
  92.    package.
  93.    2) You make it as easy as possible to acquire the extra ₧les.
  94.  
  95.    This software is supplied öasáisò: I make no warranty, expressed or
  96. implied, of the merchantability of this software or its ₧tness for any
  97. particular purpose. In no circumstances shall I be liable for any damage,
  98. loss of pro₧ts, or any indirect or consequential loss arising out of the use
  99. of this software or inability to use this software, even if I have been
  100. advised of the possibility of such loss.
  101.  
  102.    In other words, if your computer crashes, blows up, you lose all your work
  103. etc. all because of Smart Quotes (unlikely I know), donæt blame me.
  104.  
  105.    If you use this at all, please write to me or e-mail me (see below)
  106. telling me how wonderful or how atrocious it is. Itæs always nice to hear
  107. from people.
  108.  
  109. About all these strange foreign characters in this ₧le
  110. *******************************************************
  111.  
  112.    OK, so if youære reading this on a PC or a Mac or another strange machine
  113. like that, you may be wondering what all these strange ae things are. Well,
  114. theyære quotes (sorry, there was another one), dashes, ligatures, etc.
  115. Honest. But not on all machines...
  116.  
  117.    Basically, character sets are only standard up to character 127, which is
  118. basically alphanumerics and a few standard punctuation marks. Foreign
  119. characters, typographical oddities like quotes and ligatures, and other more
  120. obscure symbols are önon-standardò, and each computer often has its own idea
  121. of where they should go in the character set. So donæt worry: even if itæs
  122. hard to read on your current machine, it wonæt be on an Acorn machine.
  123.  
  124. Iæm using an Acorn machine and it still looks strange
  125. *****************************************************
  126.  
  127.    Thatæs because youære using the System font. Quotes look OK in the system
  128. font, but dashes and other ligatures or diphthongs look squashed. If youære
  129. reading this in Edit or another editor that knows about outline fonts, change
  130. to an outline font; if youære using Zap, complain bitterly about its lack of
  131. understanding of proportional fonts (if you havenæt come across this
  132. öfeatureò of Zap, try it and be amazed), and load the ₧le into Edit.
  133.  
  134.    If the lines look spaced out in Edit, set Line spacing to -2 or
  135. something.
  136.  
  137.    If you want to see why diphthongs are actually useful, use a serif font
  138. (like Trinity) rather than a sans-serif font (like Homerton); even better,
  139. use the Italic version. The difference is quite spectacular.
  140.  
  141. Quotation marks
  142. ***************
  143.  
  144.    Operation of the program is (hopefully) self-explanatory; the principles
  145. behind it may not be. What the program basically does is sit in the
  146. background, and intercept all the key presses, substituting double and single
  147. quotes according to the current settings, as well as ligatures or
  148. diphthongs. Double quotes are very simple: it just substitutes neutral
  149. quotes (ö) by ö and ò alternatively, which should be OK in the vast majority
  150. of cases (unless you are using lots of nested quotations). You can of course
  151. turn double quote substitution off, for instance if you are programming, and
  152. leave single quote substitution on.
  153.  
  154.    The problem is single quotes. Because SmartQuotes has no knowledge of what
  155. you have previously typed, it doesnæt know, when you type an apostrophe (É),
  156. whether you are starting or closing a quotation (e.g. Ésome textæ), or
  157. whether the apostrophe is part of a word (e.g. ödonætò). So, if it tries to
  158. substitute single quotes like double quotes, i.e. alternating open and double
  159. single quotes, it will often get it wrong. As most people donæt use single
  160. quotes a lot, but use apostrophes all the time, SmartQuotes will
  161. automatically substitute neutral single quotes by apostrophes; however, there
  162. is an option to substitute neutral single quotes alternatively with É and æ.
  163. Of course, if youære still not satis₧ed, you can turn the whole thing off
  164. and stick to double quotes.
  165.  
  166.    Also, it will often not substitute quotes in a writable icon ù keys are
  167. usually handled directly by the WIMP in writable icons, so Smart Quotes
  168. doesnæt get to hear about them. You have to insert them manually ù
  169. Shift-Adjust-clicking on any of Smart Quotesæ windowsæ close icon will run
  170. !Chars (or whatever character viewer you have chosen - see öOther choicesò).
  171.  
  172. Ligatures and diphthongs
  173. ************************
  174.  
  175.    Diphthongs are special characters made out of two other characters östuck
  176. togetherò, like µ (öaò+öeò). This looks more impressive in upper-case: ╞.
  177. Ligatures are special characters made out of two characters östuck
  178. togetherò, like ₧ (öfò + öiò). I canæt show you this in upper-case, because
  179. F and I donæt stick in upper-case.
  180.  
  181.    Thatæs the difference between diphthongs and ligatures (I think - someone
  182. out there who knows much better than I do will probably correct me).
  183. Diphthongs are linguistic combinations, ligatures are typographical
  184. combinations.
  185.  
  186.    Do not think for a moment that you have to remember this. Itæs quite a
  187. trivial difference anyway, certainly as far as this program is concerned. In
  188. this documentation, I will use ödiphthongò and öligatureò to mean the same
  189. thing, a special character made out of two other characters.
  190.  
  191.    Anyway, Smart Quotes maintains a list of characters and diphthongs (fully
  192. customisable), and scans keypresses like it does for quotes. Whenever two
  193. characters are typed in succession, it looks in its tables to see whether
  194. they should form a diphthong; if they should, it deletes the ₧rst one, and
  195. inserts the required diphthong. So if you type an öfò, and then immediately
  196. afterwards an öiò, it will delete the öfò, and replace the öiò by the magic
  197. character, ö₧ò. Itæs all straightforward (to use, anyway).
  198.  
  199.    Remember, however, that you have to type the two characters in immediate
  200. succession ù if you type a hyphen, then something else, then type another
  201. hyphen after it, nothing will happen. To replace a hyphen by an en-dash, you
  202. have to delete it, then type two hyphens.
  203.  
  204.    Also, when you delete a diphthong, you delete the whole thing. You canæt
  205. type ö₧ò, type delete, and end up with a normal öfò: Smart Quotes knows
  206. youære deleting something, but doesnæt know what (you could have moved the
  207. cursor, changed windows, anything). Itæs a small problem; I hope it doesnæt
  208. irritate you too much.
  209.  
  210.    See öDiphthongs windowò for more details about how to add diphthongs
  211. yourself, and öUsing diphthongsò for more hints and tips.
  212.  
  213. Typing mistakes
  214. ***************
  215.  
  216.    Typing mistakes, known as ötyposò for short: most of them  are either
  217. wrong capitalisation or transposition of two letters. Short of having a
  218. massive dictionary Smart Quotes canæt help you with transposition ù and
  219. anyway if youære using this in a word processor you will have a spell checker
  220. ù, but it can make an intelligent guess at correcting capitalisation.
  221.  
  222.    What usually happens is this: you have Caps Lock turned off, and you want
  223. to type a word beginning with a capital letter, so you press Shift to make
  224. the ₧rst letter a capital ù and then you leave it on too long so the second
  225. letter ends up capitalised as well. Youæve usually let it go by the time you
  226. type the third letter, so you end up WIth WOrds THat LOok SOmething LIke
  227. THis. If you have typing mistake checking turned on, and you type two capital
  228. letters at the beginning of a word and then a lower-case letter, Smart Quotes
  229. will replace the second capital letter by a lower-case letter, so you end up
  230. With Words That Look Something Like This.
  231.  
  232.    This is the option that is least likely to cause you problems, as it
  233. doesnæt involve any fancy characters that some programs donæt like. Only turn
  234. it off it you will be typing words like NExT a lot of the time, or if case
  235. matters (variable names, SWI names etc.).
  236.  
  237. Menu structure, windows
  238. ***********************
  239.  
  240.    Smart Quotes now supports interactive help, so I will only explain things
  241. in this ₧le that wouldnæt ₧t in the interactive help messages. Interactive
  242. help should by default be turned on; if it isnæt, select öInteractive helpò
  243. in the Choices window, available from the menu option öChoices...ò in the
  244. icon bar menu.
  245.  
  246. Diphthong menu
  247. **************
  248.  
  249.    Save saves a ₧le called öDiphthongsò in the directory pointed to by the
  250. variable SmartQuotes$ChoicesDir, which is by default SmartQuotes$Dir but can
  251. be changed to point elsewhere if the Smart Quotes directory is read-only or
  252. restricted access (i.e. on a network) in the öOther choicesò window (see
  253. below). The Diphthongs ₧le is a simple Obey ₧le, so double-clicking on it
  254. will load the diphthongs.
  255.  
  256.    Refresh: basically, choose this option if you want to make sure the front
  257. end really knows what characters are going to be substituted. Usually it
  258. does, but if you have modi₧ed the diphthongs in the command line, or by
  259. double-clicking on another Diphthongs ₧le, you have to tell it the
  260. diphthongs have changed.
  261.  
  262. Settings window
  263. ***************
  264.  
  265.    The settings dialogue box determines how characters will be substituted.
  266. Choices take effect immediately, so playing around with the different
  267. options and typing to see what happens is usually the best way to work out
  268. what they all mean.
  269.  
  270.    The dialogue box can take two different forms, depending on the current
  271. choices, which will be reƒected in the title of the window. The default form
  272. is the graphical form ù öShow options as iconsò. You can switch between the
  273. two forms by Adjust-clicking on the windowæs close icon.
  274.  
  275. Choices dialogue box
  276. ********************
  277.  
  278.    This dialogue box affects the working of the front-end, and so doesnæt
  279. affect substitution of quotes: itæs mainly cosmetics. Changes take effect
  280. immediately. See also the öOther choicesò window.
  281.  
  282.    öShow next quote in iconò: If this option is selected, Smart Quotesæ icon
  283. on the icon bar, to the left of the Palette, will change from the standard
  284. Quotes icon (Éæ) to a representation of what double and single quotes would
  285. be represented by (i.e. either an open, double or neutral quote). Again, the
  286. effect is cumbersome to explain in words and very easy to understand when
  287. you can see what is going on ù but basically, its main use is to show you
  288. what the next quote is going to be, so if you donæt like what it will give
  289. you, you can change the options. It doesnæt show ligatures because there are
  290. so many of them.
  291.  
  292.    öRemember quotesæ stateò: If selected, when you temporarily disable quotes
  293. substitution by Adjust-clicking on the iconbar icon, Smart Quotes will
  294. remember the state of the quotes, and restore it when you re-enable
  295. substitution; otherwise, it will reset the quotesæ state to the default
  296. value. So for instance, if you type a double quote (so the next one will be
  297. closed), turn off substitution, do something, then turn it back on, and
  298. type a double quote, if öRemember quotesæ stateò is on you will get a closed
  299. quote, otherwise you will get another open quote.
  300.    You should select this option if you usually disable substitution to type
  301. something, then re-enable substitution and carry on where you left off.
  302. Conversely, if you usually disable substitution because you typed a smart
  303. quote rather than a neutral quote, and want to avoid that happening again,
  304. when you really *do* want to type a smart quote you will probably want to
  305. start with an open quote, so you should de-select this option.
  306.  
  307.    öInteractive helpò: If selected, you will get interactive help on all of
  308. Smart Quotesæ windows and icons; if not, you wonæt. As mentioned above, this
  309. is supplied with the module More Help, which means it doesnæt eat up any of
  310. Smart Quotesæ memory ù it does use some in the Module Area, though.
  311.  
  312.    öÉQuitæ kills moduleò: If selected, when you quit the front-end, the
  313. ÉSmartQuotesæ module will be killed, thus stopping all substitution. If you
  314. want substitution to carry on after you quit the front-end (if you are short
  315. of memory, for instance), turn this option off. Bear in mind, however, that
  316. without the front-end you will need to use the command line (F12 or
  317. Ctrl-F12) to modify the settings; also, when you quit the front-end, you may
  318. have forgotten the module is still running and substituting quotes.
  319. Programmers beware!
  320.  
  321. Other choices
  322. *************
  323.  
  324.    The öOther choicesò window is different from the other windows, in that
  325. changes you make in this window do not take effect immediately. This is due
  326. to the special nature of the Other choices window, which is in fact öownedò
  327. by another application, as it wouldnæt ₧t in the main Smart Quotes
  328. application ù which explains the disc access when you click on the öOther...ò
  329. button in the Choices window.
  330.  
  331.    In this window you can change the font styles Smart Quotes uses for the
  332. öDiphthongsò window, the öEdit diphthongsò window and the öCharactersò
  333. window; you can change the application to be run when you Shift-Adjust click
  334. on a close icon (the öcharacter viewerò); and you can change where Smart
  335. Quotes stores its Choices ₧les, if you are running Smart Quotes from a
  336. read-only ₧ling system like a network, a CD or a protected hard disc.
  337.  
  338.    Full interactive help is provided, so there shouldnæt be too many
  339. difficulties. The following comments may be useful:
  340.  
  341.    Å You donæt have to drag an application to the window to change the
  342. character viewer; you can drag a ₧le as well. (Unfortunately you cannot use a
  343. directory - you canæt have everything). The ₧le will be run using *WimpTask,
  344. which will run the ₧le without telling applications ù so if you run a Draw₧le
  345. and Draw (or a similar application) is running, a second copy of Draw will be
  346. loaded. Therefore, the best ₧les to use are Obey, Command, the TaskWindow
  347. equivalents, Desktop or similar ₧les.
  348.  
  349.    Å You can change the location of the Choices directory (usually called
  350. öSQáChoicesò but you can modify the actual ₧lename by editing the writable
  351. ₧eld); when you click öSave and useò, if the ₧lename is different the ₧les
  352. will be copied from their old location to their new one. Smart Quotes will
  353. then try and update the öChoicesò ₧le in the (NB) *Smart Quotes* directory ù
  354. which may be write-protected. In this case, Smart Quotes will try and save it
  355. in the Scrap directory. This also happens if the new choices directory is
  356. write protected. If you donæt have a Scrap directory set up (i.e. you havenæt
  357. öseenò Scrap if you have RISC OS 3.1) the save will fail.
  358.  
  359.    Å When you modify one of the options, the title bar will change to öOther
  360. choices *ò to show that the choices have been modi₧ed.
  361.  
  362. Characters dialogue box
  363. ***********************
  364.  
  365.    Clicking Default will revert to default settings. An individual character
  366. will also revert to default if the ₧eld is left blank.
  367.  
  368.    Clicking Save will save the preferred characters to a ₧le called
  369. ö<SmartQuotes$ChoicesDir>.Charsò (see above). This is a standard Obey ₧le,
  370. and so is human-readable and editable (unlike the rather obscure Choices ₧le
  371. ;) ). Again, like the Diphthongs ₧le, running it from a Filer window will
  372. load the characters (provided Smart Quotes is running, of course).
  373.  
  374.    Clicking Refresh will re-scan the characters, in case you have changed
  375. the de₧nitions via the command line or by double-clicking on another Chars
  376. ₧le.
  377.  
  378. Diphthongs window
  379. *****************
  380.  
  381.    Choosing òDiphthongs...ö from the main menu will open the Diphthongs
  382. window, containing a list of all the current diphthongs. The list is divided
  383. into three columns, somewhat like this:
  384.  
  385.    First  Second  Subst
  386.    -      -       ù
  387.    ù      -       ÿ
  388.    ÿ      -       Å
  389.    f      i       ₧
  390.    f      l       ƒ
  391.  
  392.    The window uses an outline font (Trinity.Medium for the text,
  393. Homerton.Bold for the heading, by default) so you can see exactly what is
  394. going on.
  395.  
  396.    The First column contains the ₧rst character in the sequence, the Second
  397. column the second character, the Subst column the character that replaces
  398. the two.
  399.  
  400. Using diphthongs
  401. ****************
  402.  
  403.    Most diphthongs in the list are fairly straightforward: f and i make ₧, -
  404. twice produces an en-dash (ù). There is however more than that to diphthongs:
  405. you can combine several diphthongs. For instance, to get a longer em-dash,
  406. type - three times: it will be substituted by an en-dash, and then by an
  407. em-dash, as another diphthong was de₧ned as ù + - = ÿ. For when a diphthong
  408. is substituted, it simulates a key-press, and can therefore be the ₧rst part
  409. of another diphthong. (Typing - yet again will turn the em-dash into a bullet
  410. Å, as yet another diphthong was de₧ned as ÿ + - = Å).
  411.  
  412.    Another example is fractions. 1 and / produce ╣; afterwards, typing
  413. either 2 or 4 will get ╜ or ╝, as diphthongs have been de₧ned for ╣ and 2
  414. and ╣ and 4.
  415.  
  416.    Accents can also be provided: e and / results in Θ, e and \ in Φ, etc.
  417. Circumƒexes are more difficult (you need a ^, which uses Shift), and umlauts
  418. are downright difficult: " is already used, and using a colon is dangerous as
  419. colons are commonly used after vowels. You could always use ú or |.
  420.  
  421.    Cautionary tale: at one point I was going through the list of ligatures
  422. in the character set, and found ö¢ò. Having just done µ, I added o + e = ¢.
  423. Then I typed ödoesò. Oops. So beware: donæt add diphthongs just because
  424. thereæs a character that *could* be substituted - you might not want to use
  425. it. 
  426.  
  427. How to contact me
  428. *****************
  429.  
  430. All bug-reports, suggestions, comments or indeed any feedback at all will be
  431. welcomed. Hereæs how to get to me:
  432.  
  433. E-mail     : 9262861k@arts.gla.ac.uk, 926286ki@udcf.gla.ac.uk during term-time
  434.              These should be OK until June 1996
  435.              At Christmas, Easter and during the summer, you can get me at
  436.              wombat@altern.com, wombat@email.teaser.com or sam@altern.com, in order
  437.              of preference (that is, if mail bounces off one of these or I donæt
  438.              answer within a week send to the next one).
  439.  
  440. Snail-mail : My term-time address, at least until June 1995, is:
  441.              Sam Kington
  442.              Flat 2/1
  443.              44 Hotspur Street
  444.              Glasgow G20 8NL
  445.              SCOTLAND
  446.              
  447.              Again, a backup is the home address ù anything that goes here will get
  448.              to me eventually.
  449.              Sam Kington
  450.              Merlhiot
  451.              24420 Savignac les Eglises
  452.              FRANCE
  453.  
  454. Term-time is October to June, with bits off at Christmas (3 weeks) and
  455. Easter (4 weeks).
  456.